<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="OpenSocialHelper,org.opensocial.client.core.OpenSocialHelper,fetchActivities,fetchPeople,fetchPerson,fetchPersonAppData,getContainerDomain,getDomain,removePersonAppData,requestCreateActivity,requestPermission,requestSendMessage,requestShareApp,supportsField,updatePersonAppData" name="keywords">
<title>org.opensocial.client.core.OpenSocialHelper</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'OpenSocialHelper - OpenSocial Actionscript 3.0 Client Library Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">OpenSocial AS3 Client Library</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/opensocial/client/core/OpenSocialHelper.html&amp;org/opensocial/client/core/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;OpenSocialHelper</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class OpenSocialHelper"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.opensocial.client.core</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class OpenSocialHelper</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">OpenSocialHelper <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> org.opensocial.client.core.ClientHelper</td>
</tr>
</table>
<p></p>
 Features helper for <code><j>opensocial</j></code> namespaces. This is the core namespace for
 the Opensocial API.
 <p>
 It contains the those remote data asynchronous requests to people, activities and data services
 which can be applied to both jswrapper and restful client. And some environment related features
 which may be only used in jswrapper client.
 </p>
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial" target="mm_external">opensocial</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#OpenSocialHelper()">OpenSocialHelper</a>(client:<a href="OpenSocialClient.html">OpenSocialClient</a>)</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#fetchActivities()">fetchActivities</a>(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, callback:Function = null, params:Object = null):void</div>
<div class="summaryTableDescription">
   Sends request to fetch activities for people.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#fetchPeople()">fetchPeople</a>(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, callback:Function = null, params:Object = null):void</div>
<div class="summaryTableDescription">
   Sends request to fetch friends.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#fetchPerson()">fetchPerson</a>(id:String, callback:Function = null, params:Object = null):void</div>
<div class="summaryTableDescription">
   Sends request to fetch a person.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#fetchPersonAppData()">fetchPersonAppData</a>(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, keys:Array, callback:Function = null, params:Object = null):void</div>
<div class="summaryTableDescription">
   Sends request to fetch person app data.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getContainerDomain()">getContainerDomain</a>():String</div>
<div class="summaryTableDescription">
   Extract the container domain from the document.referer field.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getDomain()">getDomain</a>():String</div>
<div class="summaryTableDescription">
   Calls the <code><j>opensocial.Environment.getDomain</j></code> to get the domain of the
   running conatiner.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removePersonAppData()">removePersonAppData</a>(id:String, keys:Array, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to remove the person app data.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#requestCreateActivity()">requestCreateActivity</a>(activity:<a href="../base/Activity.html">Activity</a>, priority:String, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to create an activity.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#requestPermission()">requestPermission</a>(permissions:Array, reasonText:String, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to share this app.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#requestSendMessage()">requestSendMessage</a>(recipients:Array, message:<a href="../base/Message.html">Message</a>, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to send a message.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#requestShareApp()">requestShareApp</a>(recipients:Array, reason:<a href="../base/Message.html">Message</a>, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to share this app.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#supportsField()">supportsField</a>(objectType:String, field:String):Boolean</div>
<div class="summaryTableDescription">
   Calls the <code><j>opensocial.Environment.supportsField</j></code> to check if the field
   in the type is supported for this container.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#updatePersonAppData()">updatePersonAppData</a>(id:String, key:String, value:Object, callback:Function = null):void</div>
<div class="summaryTableDescription">
   Sends request to update the person app data.</div>
</td><td class="summaryTableOwnerCol">OpenSocialHelper</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="OpenSocialHelper()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OpenSocialHelper</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function OpenSocialHelper(client:<a href="OpenSocialClient.html">OpenSocialClient</a>)</code><p>
   Constructor.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">client</span>:<a href="OpenSocialClient.html">OpenSocialClient</a></code> &mdash; The opensocial client instance.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="fetchActivities()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fetchActivities</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function fetchActivities(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, callback:Function = null, params:Object = null):void</code><p>
   Sends request to fetch activities for people.
   Js-side.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">idSpec</span>:<a href="../base/IdSpec.html">IdSpec</a></code> &mdash; An <code>IdSpec</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is <code>Collection</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; A <code>Map.&lt;DataRequest.ActivityRequestFields, Object&gt;</code> object.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newFetchActivitiesRequest" target="mm_external">opensocial.DataRequest.newFetchActivitiesRequest</a>
</div>
</div>
<a name="fetchPeople()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fetchPeople</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function fetchPeople(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, callback:Function = null, params:Object = null):void</code><p>
   Sends request to fetch friends.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">idSpec</span>:<a href="../base/IdSpec.html">IdSpec</a></code> &mdash; An <code>IdSpec</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is <code>Collection</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; A <code>Map.&lt;DataRequest.PeopleRequestField, Object&gt;</code> object.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newFetchPeopleRequest" target="mm_external">opensocial.DataRequest.newFetchPeopleRequest</a>
</div>
</div>
<a name="fetchPerson()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fetchPerson</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function fetchPerson(id:String, callback:Function = null, params:Object = null):void</code><p>
   Sends request to fetch a person.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; An <code>IdSpec.PersonId</code> value, can be <code>VIEWER</code> or
             <code>OWNER</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is <code>Person</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; A <code>Map.&lt;DataRequest.PeopleRequestField, Object&gt;</code> object.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newFetchPersonRequest" target="mm_external">opensocial.DataRequest.newFetchPersonRequest</a>
</div>
</div>
<a name="fetchPersonAppData()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fetchPersonAppData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function fetchPersonAppData(idSpec:<a href="../base/IdSpec.html">IdSpec</a>, keys:Array, callback:Function = null, params:Object = null):void</code><p>
   Sends request to fetch person app data.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">idSpec</span>:<a href="../base/IdSpec.html">IdSpec</a></code> &mdash; An <code>IdSpec</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">keys</span>:Array</code> &mdash; Array of key names, ' to represent all.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is
                   <code>Map.&lt;String, Map.&lt;String, Object&gt;&gt;</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; A <code>Map.&lt;DataRequest.DataRequestField, Object&gt;</code> object.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newFetchPersonAppDataRequest" target="mm_external">opensocial.DataRequest.newFetchPersonAppDataRequest</a>
</div>
</div>
<a name="getContainerDomain()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getContainerDomain</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getContainerDomain():String</code><p>
   Extract the container domain from the document.referer field. It maybe different from the
   <code>getDomain</code> method.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; The domain of the container url.
   </td>
</tr>
</table>
</div>
<a name="getDomain()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getDomain</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getDomain():String</code><p>
   Calls the <code><j>opensocial.Environment.getDomain</j></code> to get the domain of the
   running conatiner.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; The domain of the container, e.g. orkut.com, 51.com
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment.getDomain" target="mm_external">opensocial.Environment.getDomain</a>
</div>
</div>
<a name="removePersonAppData()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removePersonAppData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removePersonAppData(id:String, keys:Array, callback:Function = null):void</code><p>
   Sends request to remove the person app data.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; A <code>IdSpec.PersonId</code> value, can only be <code>VIEWER</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">keys</span>:Array</code> &mdash; Array of key names, ' to represent all.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newRemovePersonAppDataRequest" target="mm_external">opensocial.DataRequest.newRemovePersonAppDataRequest</a>
</div>
</div>
<a name="requestCreateActivity()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestCreateActivity</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function requestCreateActivity(activity:<a href="../base/Activity.html">Activity</a>, priority:String, callback:Function = null):void</code><p>
   Sends request to create an activity.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">activity</span>:<a href="../base/Activity.html">Activity</a></code> &mdash; An <code>Activity</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">priority</span>:String</code> &mdash; A value of <code>Globals.CreateActivityPriority</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.requestCreateActivity" target="mm_external">opensocial.requestCreateActivity</a>
</div>
</div>
<a name="requestPermission()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestPermission</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function requestPermission(permissions:Array, reasonText:String, callback:Function = null):void</code><p>
   Sends request to share this app.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">permissions</span>:Array</code> &mdash; An array of <code>Globals.Permission</code> values.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">reasonText</span>:String</code> &mdash; A string of reason text.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.requestPermission" target="mm_external">opensocial.requestPermission</a>
</div>
</div>
<a name="requestSendMessage()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestSendMessage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function requestSendMessage(recipients:Array, message:<a href="../base/Message.html">Message</a>, callback:Function = null):void</code><p>
   Sends request to send a message.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">recipients</span>:Array</code> &mdash; An array of ids, such as OWNER, VIEWER, or person ids in reachable groups.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">message</span>:<a href="../base/Message.html">Message</a></code> &mdash; An <code>Message</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.requestSendMessage" target="mm_external">opensocial.requestSendMessage</a>
</div>
</div>
<a name="requestShareApp()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">requestShareApp</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function requestShareApp(recipients:Array, reason:<a href="../base/Message.html">Message</a>, callback:Function = null):void</code><p>
   Sends request to share this app.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">recipients</span>:Array</code> &mdash; An array of ids, such as OWNER, VIEWER, or person ids in reachable groups.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">reason</span>:<a href="../base/Message.html">Message</a></code> &mdash; An <code>Message</code> object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.requestShareApp" target="mm_external">opensocial.requestShareApp</a>
</div>
</div>
<a name="supportsField()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">supportsField</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function supportsField(objectType:String, field:String):Boolean</code><p>
   Calls the <code><j>opensocial.Environment.supportsField</j></code> to check if the field
   in the type is supported for this container.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">objectType</span>:String</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">field</span>:String</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; True if supported.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment.supportsField" target="mm_external">opensocial.Environment.supportsField</a>
</div>
</div>
<a name="updatePersonAppData()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">updatePersonAppData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function updatePersonAppData(id:String, key:String, value:Object, callback:Function = null):void</code><p>
   Sends request to update the person app data.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; A <code>IdSpec.PersonId</code> value, can only be <code>VIEWER</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">key</span>:String</code> &mdash; One key name of the data.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; The value to be store, must be a json format.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; A fucntion with a parameter of <code>ResponseItem</code>.
                   The underlying data in the response item is null.
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.newUpdatePersonAppDataRequest" target="mm_external">opensocial.DataRequest.newUpdatePersonAppDataRequest</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">2009 OpenSocial</center>
</div>
</body>
</html>
<!--2009 OpenSocial-->
